Resource URL: /platform/<<version=4>>/sync/reports/<RID>/subreports/<SID>

    Overview: This resource applies the standard collection pattern to
              individual OneFS SyncIQ subreports.

     Methods: GET

********************************************************************************

Method GET: View a single SyncIQ subreport.

       URL: GET /platform/<<version=4>>/sync/reports/<RID>/subreports/<SID>

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "subreports": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "properties": {
              "files_new": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files created by this job."
              }, 
              "error_io_files_skipped": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files with io errors skipped by this job."
              }, 
              "policy_name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the policy."
              }, 
              "target_directories_unlinked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories unlinked on the target."
              }, 
              "network_bytes_to_source": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of bytes sent to the source by this job."
              }, 
              "hash_exceptions_fixed": {
                "required": true, 
                "type": "integer", 
                "description": "The number of hash exceptions fixed by this job."
              }, 
              "failed_chunks": {
                "required": true, 
                "type": "integer", 
                "description": "Tyhe number of data chunks that failed transmission."
              }, 
              "dirs_moved": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories moved by this job."
              }, 
              "policy": {
                "required": true, 
                "type": "object", 
                "properties": {
                  "name": {
                    "type": "string", 
                    "description": "User-assigned name of this sync policy."
                  }, 
                  "source_root_path": {
                    "type": "string", 
                    "description": "The root directory on the source cluster the files will be synced from.  Modifying this field will result in a full synchronization of all data."
                  }, 
                  "target_path": {
                    "type": "string", 
                    "description": "Absolute filesystem path on the target cluster for the sync destination."
                  }, 
                  "file_matching_pattern": {
                    "required": false, 
                    "type": "object", 
                    "description": "A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties.  Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.", 
                    "properties": {
                      "or_criteria": {
                        "items": {
                          "type": "object", 
                          "properties": {
                            "and_criteria": {
                              "items": {
                                "type": "object", 
                                "description": "An object describing one criterion for finding a matching file, for example \"size is greater than or equal to 10KB\". Note: For time types (accessed_*, birth_*, and changed_*), operator is not required (it is implicitly ==).  For the value, you can use a relative date and time, such as \"two weeks ago\", or specific date and time, such as \"January 1, 2012.\"  Time settings are based on a 24-hour clock.", 
                                "properties": {
                                  "whole_word": {
                                    "type": "boolean", 
                                    "description": "If true, the attribute must match the entire word.  Default is true."
                                  }, 
                                  "value": {
                                    "type": [
                                      "string", 
                                      "integer"
                                    ], 
                                    "description": "The value to compare the specified attribute of each file to."
                                  }, 
                                  "case_sensitive": {
                                    "type": "boolean", 
                                    "description": "If true, the value comparison will be case sensitive.  Default is true."
                                  }, 
                                  "field": {
                                    "type": "string", 
                                    "description": "The name of the file attribute to match on (only required if this is a custom_attribute type criterion).  Default is an empty string \"\"."
                                  }, 
                                  "attribute_exists": {
                                    "type": "boolean", 
                                    "description": "For \"custom_attribute\" type criteria.  The file will match as long as the attribute named by \"field\" exists.  Default is true."
                                  }, 
                                  "operator": {
                                    "enum": [
                                      "==", 
                                      "!=", 
                                      ">", 
                                      ">=", 
                                      "<", 
                                      "<=", 
                                      "!"
                                    ], 
                                    "type": "string", 
                                    "description": "How to compare the specified attribute of each file to the specified value."
                                  }, 
                                  "type": {
                                    "enum": [
                                      "name", 
                                      "path", 
                                      "accessed_time", 
                                      "accessed_before", 
                                      "accessed_after", 
                                      "birth_time", 
                                      "birth_before", 
                                      "birth_after", 
                                      "changed_time", 
                                      "changed_before", 
                                      "changed_after", 
                                      "size", 
                                      "file_type", 
                                      "posix_regex_name", 
                                      "user_name", 
                                      "user_id", 
                                      "group_name", 
                                      "group_id", 
                                      "no_user", 
                                      "no_group"
                                    ], 
                                    "type": "string", 
                                    "description": "The type of this criterion, that is, which file attribute to match on.", 
                                    "required": true
                                  }
                                }
                              }, 
                              "type": "array", 
                              "description": "An array containing individual file criterion objects each describing one criterion.  These are logically AND'ed together to form a set of criteria."
                            }
                          }
                        }, 
                        "type": "array", 
                        "description": "An array containing objects with \"and_criteria\" properties, each set of and_criteria will be logically OR'ed together to create the full file matching pattern."
                      }
                    }
                  }, 
                  "action": {
                    "enum": [
                      "copy", 
                      "sync"
                    ], 
                    "type": "string", 
                    "description": "If 'copy', source files will be copied to the target cluster.  If 'sync', the target directory will be made an image of the source directory:  Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory."
                  }, 
                  "source_include_directories": {
                    "items": {
                      "type": "string"
                    }, 
                    "type": "array", 
                    "description": "Directories that will be included in the sync.  Modifying this field will result in a full synchronization of all data."
                  }, 
                  "source_exclude_directories": {
                    "items": {
                      "type": "string"
                    }, 
                    "type": "array", 
                    "description": "Directories that will be excluded from the sync.  Modifying this field will result in a full synchronization of all data."
                  }, 
                  "target_host": {
                    "type": "string", 
                    "description": "Hostname or IP address of sync target cluster.  Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association."
                  }
                }
              }, 
              "fifos_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of fifos replicated by this job."
              }, 
              "source_directories_linked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories linked on the source."
              }, 
              "start_time": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "The time the job started in unix epoch seconds. The field is null if the job hasn't started."
              }, 
              "target_directories_linked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories linked on the target."
              }, 
              "dead_node": {
                "required": true, 
                "type": "boolean", 
                "description": "This field is true if the node running this job is dead."
              }, 
              "source_bytes_recovered": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes recovered on the source."
              }, 
              "retransmitted_files": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "The files that have been retransmitted by this job."
              }, 
              "lins_total": {
                "required": true, 
                "type": "integer", 
                "description": "The number of LINs transferred by this job."
              }, 
              "new_files_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of new files replicated by this job."
              }, 
              "dirs_changed": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories changed by this job."
              }, 
              "total_phases": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of phases for this job."
              }, 
              "files_unlinked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files unlinked by this job."
              }, 
              "sockets_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of sockets replicated by this job."
              }, 
              "end_time": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "The time the job ended in unix epoch seconds. The field is null if the job hasn't ended."
              }, 
              "source_directories_visited": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories visited on the source."
              }, 
              "bytes_transferred": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes that have been transferred by this job."
              }, 
              "regular_files_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of regular files replicated by this job."
              }, 
              "file_data_bytes": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes transferred that belong to files."
              }, 
              "target_directories_deleted": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories deleted on the target."
              }, 
              "hash_exceptions_found": {
                "required": true, 
                "type": "integer", 
                "description": "The number of hash exceptions found by this job."
              }, 
              "duration": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "The amount of time in seconds between when the job was started and when it ended.  If the job has not yet ended, this is the amount of time since the job started.  This field is null if the job has not yet started."
              }, 
              "sparse_data_bytes": {
                "required": true, 
                "type": "integer", 
                "description": "The number of sparse data bytes transferred by this job."
              }, 
              "phases": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "phase": {
                      "type": "string", 
                      "description": "The phase that the job was in."
                    }, 
                    "start_time": {
                      "type": [
                        "integer", 
                        "null"
                      ], 
                      "description": "The time the job began this phase."
                    }, 
                    "end_time": {
                      "type": [
                        "integer", 
                        "null"
                      ], 
                      "description": "The time the job ended this phase."
                    }
                  }
                }, 
                "required": true, 
                "type": "array", 
                "description": "Data for each phase of this job."
              }, 
              "errors": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "A list of error messages for this job."
              }, 
              "resynced_lins": {
                "required": true, 
                "type": "integer", 
                "description": "The number of LINs resynched by this job."
              }, 
              "bytes_recoverable": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes recoverable by this job."
              }, 
              "state": {
                "required": true, 
                "description": "The state of the job.", 
                "minLength": 0, 
                "enum": [
                  "scheduled", 
                  "running", 
                  "paused", 
                  "finished", 
                  "failed", 
                  "canceled", 
                  "needs_attention", 
                  "skipped", 
                  "pending", 
                  "unknown"
                ], 
                "maxLength": 255, 
                "type": "string"
              }, 
              "block_specs_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of block specs replicated by this job."
              }, 
              "sync_type": {
                "enum": [
                  "invalid", 
                  "legacy", 
                  "initial", 
                  "incremental", 
                  "upgrade", 
                  "fofb", 
                  "domainmark"
                ], 
                "type": "string", 
                "description": "The type of sync being performed by this job.", 
                "required": true
              }, 
              "job_id": {
                "required": true, 
                "type": [
                  "integer", 
                  "null"
                ], 
                "description": "The ID of the job."
              }, 
              "corrected_lins": {
                "required": true, 
                "type": "integer", 
                "description": "The number of LINs corrected by this job."
              }, 
              "action": {
                "enum": [
                  "resync_prep", 
                  "allow_write", 
                  "allow_write_revert", 
                  "test", 
                  "run", 
                  "none"
                ], 
                "type": "string", 
                "description": "The action to be taken by this job.", 
                "required": true
              }, 
              "target_files_unlinked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files unlinked on the target."
              }, 
              "total_data_bytes": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of bytes transferred by this job."
              }, 
              "symlinks_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of symlinks replicated by this job."
              }, 
              "source_files_unlinked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files unlinked on the source."
              }, 
              "total_chunks": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of data chunks transmitted by this job."
              }, 
              "files_with_ads_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files with ads replicated by this job."
              }, 
              "target_files_deleted": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files deleted on the target."
              }, 
              "dirs_new": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories created by this job."
              }, 
              "files_selected": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files selected by this job."
              }, 
              "num_retransmitted_files": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files that have been retransmitted by this job."
              }, 
              "target_snapshots": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "The target snapshots created by this job."
              }, 
              "error_net_files_skipped": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files with network errors skipped by this job."
              }, 
              "unchanged_data_bytes": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes unchanged by this job."
              }, 
              "target_bytes_recovered": {
                "required": true, 
                "type": "integer", 
                "description": "The number of bytes recovered on the target."
              }, 
              "user_conflict_files_skipped": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files with user conflicts skipped by this job."
              }, 
              "target_files_linked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files linked on the target."
              }, 
              "files_transferred": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files transferred by this job."
              }, 
              "policy_action": {
                "enum": [
                  "copy", 
                  "sync"
                ], 
                "type": "string", 
                "description": "This is the action the policy is configured to perform.", 
                "required": true
              }, 
              "running_chunks": {
                "required": true, 
                "type": "integer", 
                "description": "The number of data chunks currently being transmitted."
              }, 
              "network_bytes_to_target": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of bytes sent to the target by this job."
              }, 
              "error": {
                "required": true, 
                "type": "string", 
                "description": "The primary error message for this job."
              }, 
              "directories_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories replicated."
              }, 
              "total_network_bytes": {
                "required": true, 
                "type": "integer", 
                "description": "The total number of bytes sent over the network by this job."
              }, 
              "source_directories_deleted": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories deleted on the source."
              }, 
              "target_directories_created": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories created on the target."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "A unique identifier for this object."
              }, 
              "flipped_lins": {
                "required": true, 
                "type": "integer", 
                "description": "The number of LINs flipped by this job."
              }, 
              "char_specs_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of char specs replicated by this job."
              }, 
              "updated_files_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of updated files replicated by this job."
              }, 
              "source_directories_unlinked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories unlinked on the source."
              }, 
              "ads_streams_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of ads streams replicated by this job."
              }, 
              "total_files": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files affected by this job."
              }, 
              "source_files_linked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files linked on the source."
              }, 
              "warnings": {
                "items": {
                  "type": "string"
                }, 
                "required": true, 
                "type": "array", 
                "description": "A list of warning messages for this job."
              }, 
              "source_directories_created": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories created on the source."
              }, 
              "hard_links_replicated": {
                "required": true, 
                "type": "integer", 
                "description": "The number of hard links replicated by this job."
              }, 
              "succeeded_chunks": {
                "required": true, 
                "type": "integer", 
                "description": "The number of data chunks that have been transmitted successfully."
              }, 
              "files_changed": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files changed by this job."
              }, 
              "retry": {
                "required": true, 
                "type": "integer", 
                "description": "The number of times the job has been retried."
              }, 
              "worm_committed_file_conflicts": {
                "required": true, 
                "type": "integer", 
                "description": "The number of WORM committed files which needed to be reverted. Since WORM committed files cannot be reverted, this is the number of files that were preserved in the compliance store."
              }, 
              "error_checksum_files_skipped": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files with checksum errors skipped by this job."
              }, 
              "dirs_deleted": {
                "required": true, 
                "type": "integer", 
                "description": "The number of directories deleted by this job."
              }, 
              "files_linked": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files linked by this job."
              }, 
              "up_to_date_files_skipped": {
                "required": true, 
                "type": "integer", 
                "description": "The number of up-to-date files skipped by this job."
              }, 
              "source_files_deleted": {
                "required": true, 
                "type": "integer", 
                "description": "The number of files deleted on the source."
              }, 
              "policy_id": {
                "required": true, 
                "type": "string", 
                "description": "The ID of the policy."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}
